<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Libusb++: LibUSB::InterfaceImpl Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Libusb++
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">A C++ libusb wrapper</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_lib_u_s_b_1_1_interface_impl.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="class_lib_u_s_b_1_1_interface_impl-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">LibUSB::InterfaceImpl Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:adc39b13c3b9ad9971f2cf4d747d18ce5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc39b13c3b9ad9971f2cf4d747d18ce5"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>InterfaceImpl</b> (const libusb_interface *pInterface, std::weak_ptr&lt; <a class="el" href="class_lib_u_s_b_1_1_device_impl.html">DeviceImpl</a> &gt; pDeviceImpl)</td></tr>
<tr class="memitem:ac39d098fbebc024d3f1a3b0ee7670007"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lib_u_s_b_1_1_interface_impl.html#ac39d098fbebc024d3f1a3b0ee7670007">~InterfaceImpl</a> ()</td></tr>
<tr class="memitem:a03d7483de08f48f1ce00fd89efac5827"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a03d7483de08f48f1ce00fd89efac5827"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lib_u_s_b_1_1_interface_impl.html#a03d7483de08f48f1ce00fd89efac5827">Number</a> () const </td></tr>
<tr class="memdesc:a03d7483de08f48f1ce00fd89efac5827"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the interface number. <br/></td></tr>
<tr class="memitem:a4a8737d90c753a33f3e14339c438a462"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4a8737d90c753a33f3e14339c438a462"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lib_u_s_b_1_1_interface_impl.html#a4a8737d90c753a33f3e14339c438a462">AlternateSetting</a> () const </td></tr>
<tr class="memdesc:a4a8737d90c753a33f3e14339c438a462"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the alternate setting for this interface. <br/></td></tr>
<tr class="memitem:a081dae4a2eb6df4ef6024d5349f34089"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a081dae4a2eb6df4ef6024d5349f34089"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lib_u_s_b_1_1_interface_impl.html#a081dae4a2eb6df4ef6024d5349f34089">Class</a> () const </td></tr>
<tr class="memdesc:a081dae4a2eb6df4ef6024d5349f34089"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the interface class. <br/></td></tr>
<tr class="memitem:ab273906ca4e28180ea355291a75f7ee3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab273906ca4e28180ea355291a75f7ee3"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lib_u_s_b_1_1_interface_impl.html#ab273906ca4e28180ea355291a75f7ee3">SubClass</a> () const </td></tr>
<tr class="memdesc:ab273906ca4e28180ea355291a75f7ee3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the interface Subclass. <br/></td></tr>
<tr class="memitem:a154bcb2b59473c74b662684db819191f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a154bcb2b59473c74b662684db819191f"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lib_u_s_b_1_1_interface_impl.html#a154bcb2b59473c74b662684db819191f">Protocol</a> () const </td></tr>
<tr class="memdesc:a154bcb2b59473c74b662684db819191f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the interface Protocol. <br/></td></tr>
<tr class="memitem:a561038e788c9292f252e4383398cd1a2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a561038e788c9292f252e4383398cd1a2"></a>
std::wstring&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lib_u_s_b_1_1_interface_impl.html#a561038e788c9292f252e4383398cd1a2">DescriptorString</a> () const </td></tr>
<tr class="memdesc:a561038e788c9292f252e4383398cd1a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a string descriptor for this interface. <br/></td></tr>
<tr class="memitem:a02737338ff031a77327fc54e4375e59a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a02737338ff031a77327fc54e4375e59a"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lib_u_s_b_1_1_interface_impl.html#a02737338ff031a77327fc54e4375e59a">NumAlternateSettings</a> () const </td></tr>
<tr class="memdesc:a02737338ff031a77327fc54e4375e59a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of available alternate settings for this interface. <br/></td></tr>
<tr class="memitem:a7bc22950574a6e53becd3305cc06d796"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7bc22950574a6e53becd3305cc06d796"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lib_u_s_b_1_1_interface_impl.html#a7bc22950574a6e53becd3305cc06d796">Claim</a> ()</td></tr>
<tr class="memdesc:a7bc22950574a6e53becd3305cc06d796"><td class="mdescLeft">&#160;</td><td class="mdescRight">Claims this interface for use. <br/></td></tr>
<tr class="memitem:a70b99c5ba75c199cf795d54bb425a6b0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a70b99c5ba75c199cf795d54bb425a6b0"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lib_u_s_b_1_1_interface_impl.html#a70b99c5ba75c199cf795d54bb425a6b0">Release</a> ()</td></tr>
<tr class="memdesc:a70b99c5ba75c199cf795d54bb425a6b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases this interface. <br/></td></tr>
<tr class="memitem:a5bc5802fbdec9afc6b06ac1896aded0a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5bc5802fbdec9afc6b06ac1896aded0a"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lib_u_s_b_1_1_interface_impl.html#a5bc5802fbdec9afc6b06ac1896aded0a">isClaimed</a> () const </td></tr>
<tr class="memdesc:a5bc5802fbdec9afc6b06ac1896aded0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns TRUE if the interface is claimed. <br/></td></tr>
<tr class="memitem:ad4ff414a8e5f576b4e03bad9a9c7f026"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lib_u_s_b_1_1_interface_impl.html#ad4ff414a8e5f576b4e03bad9a9c7f026">SetAlternate</a> (uint8_t <a class="el" href="class_lib_u_s_b_1_1_interface_impl.html#a4a8737d90c753a33f3e14339c438a462">AlternateSetting</a>=0)</td></tr>
<tr class="memdesc:ad4ff414a8e5f576b4e03bad9a9c7f026"><td class="mdescLeft">&#160;</td><td class="mdescRight">Selects an alternate interface setting.  <a href="#ad4ff414a8e5f576b4e03bad9a9c7f026"></a><br/></td></tr>
<tr class="memitem:a860d06febe31d53c83e6634413ebc16f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a860d06febe31d53c83e6634413ebc16f"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lib_u_s_b_1_1_interface_impl.html#a860d06febe31d53c83e6634413ebc16f">NumEndpoints</a> () const </td></tr>
<tr class="memdesc:a860d06febe31d53c83e6634413ebc16f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of endpoints this interface/altsetting has. <br/></td></tr>
<tr class="memitem:a48711e334241d5cdc8264446ced1b880"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="class_lib_u_s_b_1_1_endpoint.html">Endpoint</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lib_u_s_b_1_1_interface_impl.html#a48711e334241d5cdc8264446ced1b880">getEndpoint</a> (uint8_t index)</td></tr>
<tr class="memdesc:a48711e334241d5cdc8264446ced1b880"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the specified endpoint.  <a href="#a48711e334241d5cdc8264446ced1b880"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aaaf659898f5c20b7f5f581730a7bec1c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaaf659898f5c20b7f5f581730a7bec1c"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lib_u_s_b_1_1_interface_impl.html#aaaf659898f5c20b7f5f581730a7bec1c">ReleaseEndpoints</a> ()</td></tr>
<tr class="memdesc:aaaf659898f5c20b7f5f581730a7bec1c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets all endpoints. <br/></td></tr>
<tr class="memitem:acfa412a39f78e179080313f004552f2e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acfa412a39f78e179080313f004552f2e"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lib_u_s_b_1_1_interface_impl.html#acfa412a39f78e179080313f004552f2e">CreateEndpoints</a> ()</td></tr>
<tr class="memdesc:acfa412a39f78e179080313f004552f2e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates all endpoint objects. <br/></td></tr>
</table>
<h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ac39d098fbebc024d3f1a3b0ee7670007"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">LibUSB::InterfaceImpl::~InterfaceImpl </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>We're not going to throw, in this particular situation. </p>

</div>
</div>
<h2>Member Function Documentation</h2>
<a class="anchor" id="a48711e334241d5cdc8264446ced1b880"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::shared_ptr&lt; <a class="el" href="class_lib_u_s_b_1_1_endpoint.html">LibUSB::Endpoint</a> &gt; LibUSB::InterfaceImpl::getEndpoint </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>index</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the specified endpoint. </p>
<dl class="section note"><dt>Note</dt><dd>#1 Validate endpoint number against its index. </dd></dl>

</div>
</div>
<a class="anchor" id="ad4ff414a8e5f576b4e03bad9a9c7f026"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void LibUSB::InterfaceImpl::SetAlternate </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>AlternateSetting</em> = <code>0</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Selects an alternate interface setting. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">AlternateSetting</td><td>(uint8_t): the index of the alternate setting to select/use. </td></tr>
  </table>
  </dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">(std::logic_error)</td><td>if the alternate setting is out-of-range. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd></dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lib_u_s_b_1_1_interface_impl.html#a02737338ff031a77327fc54e4375e59a" title="Returns the number of available alternate settings for this interface.">NumAlternateSettings() const</a> </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>If the interface is currently claimed, changing the alternate setting will affect the endpoints. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/<a class="el" href="_interfaceimpl_8h_source.html">Interfaceimpl.h</a></li>
<li>src/interfaceimpl.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><b>LibUSB</b></li><li class="navelem"><a class="el" href="class_lib_u_s_b_1_1_interface_impl.html">InterfaceImpl</a></li>
    <li class="footer">Generated on Sat Sep 8 2012 08:35:03 for Libusb++ by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.2 </li>
  </ul>
</div>
</body>
</html>
